/*
 * Copyright 2016 SimplifyOps, Inc. (http://simplifyops.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package rundeck.services.execution

/**
 * Holds results of threshold checking
 */
interface ThresholdValue<T> {
    /**
     * @return true whenever the threshold is exceeded
     */
    boolean isThresholdExceeded()

    /**
     * @return current value
     */
    T getValue()

    /**
     * @return reason string
     */
    String getDescription()

    /**
     * @return action to perform on threshold
     */
    String getAction()
}
